Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / detritus-client / structures / ChannelBase

Class ChannelBase

extends BaseStructureclass BaseStructuredetritus-client/structures/BaseStructure

Defined in channel

Basic Channel Structure

Constructor

constructor(
client: ShardClientclass ShardClientdetritus-client/ShardClient,
data?: BaseStructureDatainterface BaseStructureDatadetritus-client/structures/BaseStructureData,
isClone?: boolean
)

Properties

_keys = BaseSetclass BaseSetdetritus-utils/BaseSet<string>[src]
_keysMerge = BaseSetclass BaseSetdetritus-utils/BaseSet<string>[src]
_nicks?: BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, string>[src]
_permissionOverwrites?: BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Overwriteclass Overwritedetritus-client/structures/Overwrite>[src]
_recipients?: BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Userclass Userdetritus-client/structures/User>[src]
member?: ThreadMemberclass ThreadMemberdetritus-client/structures/ThreadMember[src]
threadMetadata?: ThreadMetadataclass ThreadMetadatadetritus-client/structures/ThreadMetadata[src]
type: ChannelTypesenum ChannelTypesdetritus-client/ChannelTypes = ChannelTypes.BASEenum ChannelTypesdetritus-client/ChannelTypes[src]
videoQualityMode?: ChannelVideoQualityModesenum ChannelVideoQualityModesdetritus-client/ChannelVideoQualityModes[src]

Methods

get children(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, ChannelGuildTypetype ChannelGuildTypedetritus-client/structures/ChannelGuildType>[src]
get createdAt(): Dateexternal Date[src]
get guild(): Guildclass Guilddetritus-client/structures/Guild | null[src]
get lastMessage(): Messageclass Messagedetritus-client/structures/Message | null[src]
get lastPinTimestamp(): Dateexternal Date | null[src]
get members(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Memberclass Memberdetritus-client/structures/Member>[src]
get messages(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Messageclass Messagedetritus-client/structures/Message>[src]
get nicks(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, string>[src]
get owner(): Userclass Userdetritus-client/structures/User | null[src]
get parent(): ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | null[src]
get permissionOverwrites(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Overwriteclass Overwritedetritus-client/structures/Overwrite>[src]
get stageInstance(): StageInstanceclass StageInstancedetritus-client/structures/StageInstance | null[src]
get recipients(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Userclass Userdetritus-client/structures/User>[src]
get typing(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Typingclass Typingdetritus-client/structures/Typing>[src]
get voiceStates(): BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, VoiceStateclass VoiceStatedetritus-client/structures/VoiceState>[src]
can(
permissions: PermissionCheckstype PermissionChecksdetritus-client/utils/PermissionChecks,
memberOrRole?: Memberclass Memberdetritus-client/structures/Member | Roleclass Roledetritus-client/structures/Role
): boolean[src]
iconUrlFormat(format?: null | string, query?: UrlQuerytype UrlQuerydetritus-client/utils/UrlQuery): null | string[src]
isSyncedWith(
parent: ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | null
): boolean[src]
addPinnedMessage(messageId: string): Promise<any>external Promise[src]
addMember(userId: string): Promise<any>external Promise[src]
addRecipient(userId: string): Promise<any>external Promise[src]
bulkDelete(messageIds: Array<string>external Array): Promise<any>external Promise[src]
close(
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
createInvite(
options: CreateChannelInviteinterface CreateChannelInvitedetritus-client-rest/RequestTypes/CreateChannelInvite
): Promise<Inviteclass Invitedetritus-client/structures/Invite>external Promise[src]
createMessage(
options: CreateMessageinterface CreateMessagedetritus-client-rest/RequestTypes/CreateMessage | string = {}
): Promise<Messageclass Messagedetritus-client/structures/Message>external Promise[src]
createReaction(
messageId: string,
emoji: string
): Promise<any>external Promise[src]
createStageInstance(
options: PartialBytype PartialBydetritus-client/utils/PartialBy<CreateStageInstanceinterface CreateStageInstancedetritus-client-rest/RequestTypes/CreateStageInstance, "channelId">
): Promise<StageInstanceclass StageInstancedetritus-client/structures/StageInstance>external Promise[src]
createThread(
options: CreateChannelThreadinterface CreateChannelThreaddetritus-client-rest/RequestTypes/CreateChannelThread
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread>external Promise[src]
createWebhook(
options: CreateWebhookinterface CreateWebhookdetritus-client-rest/RequestTypes/CreateWebhook
): Promise<Webhookclass Webhookdetritus-client/structures/Webhook>external Promise[src]
crosspostMessage(messageId: string): Promise<Messageclass Messagedetritus-client/structures/Message>external Promise[src]
delete(
options: DeleteChannelinterface DeleteChanneldetritus-client-rest/RequestTypes/DeleteChannel = {}
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
deleteMessage(
messageId: string,
options: DeleteMessageinterface DeleteMessagedetritus-client-rest/RequestTypes/DeleteMessage = {}
): Promise<any>external Promise[src]
deleteOverwrite(
overwriteId: string,
options: DeleteChannelOverwriteinterface DeleteChannelOverwritedetritus-client-rest/RequestTypes/DeleteChannelOverwrite = {}
): Promise<any>external Promise[src]
deletePin(messageId: string): Promise<any>external Promise[src]
deleteReaction(
messageId: string,
emoji: string,
userId: string = "@me"
): Promise<any>external Promise[src]
deleteReactions(messageId: string): Promise<any>external Promise[src]
deleteStageInstance(): Promise<any>external Promise[src]
edit(
options: EditChannelinterface EditChanneldetritus-client-rest/RequestTypes/EditChannel = {}
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
editMessage(
messageId: string,
options: EditMessageinterface EditMessagedetritus-client-rest/RequestTypes/EditMessage = {}
): Promise<Messageclass Messagedetritus-client/structures/Message>external Promise[src]
editOverwrite(
overwriteId: string,
options: EditChannelOverwriteinterface EditChannelOverwritedetritus-client-rest/RequestTypes/EditChannelOverwrite = {}
): Promise<any>external Promise[src]
editStageInstance(options: EditStageInstanceinterface EditStageInstancedetritus-client-rest/RequestTypes/EditStageInstance = {}): Promise<any>external Promise[src]
fetchCallStatus(): Promise<any>external Promise[src]
fetchInvites(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Inviteclass Invitedetritus-client/structures/Invite>>external Promise[src]
fetchMembers(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, ThreadMemberclass ThreadMemberdetritus-client/structures/ThreadMember>>external Promise[src]
fetchMessage(messageId: string): Promise<Messageclass Messagedetritus-client/structures/Message>external Promise[src]
fetchMessages(
options: FetchMessagesinterface FetchMessagesdetritus-client-rest/RequestTypes/FetchMessages = {}
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Messageclass Messagedetritus-client/structures/Message>>external Promise[src]
fetchPins(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Messageclass Messagedetritus-client/structures/Message>>external Promise[src]
fetchReactions(
messageId: string,
emoji: string,
options: FetchReactionsinterface FetchReactionsdetritus-client-rest/RequestTypes/FetchReactions = {}
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Userclass Userdetritus-client/structures/User>>external Promise[src]
fetchStageInstance(): Promise<StageInstanceclass StageInstancedetritus-client/structures/StageInstance>external Promise[src]
fetchStoreListing(): Promise<StoreListingclass StoreListingdetritus-client/structures/StoreListing>external Promise[src]
fetchThreadsActive(): Promise<FetchChannelThreadsActiveinterface FetchChannelThreadsActivedetritus-client/rest/RestResponses/FetchChannelThreadsActive>external Promise[src]
fetchThreadsArchivedPrivate(
options: FetchChannelThreadsArchivedPrivateinterface FetchChannelThreadsArchivedPrivatedetritus-client-rest/RequestTypes/FetchChannelThreadsArchivedPrivate = {}
): Promise<FetchChannelThreadsArchivedPrivateinterface FetchChannelThreadsArchivedPrivatedetritus-client/rest/RestResponses/FetchChannelThreadsArchivedPrivate>external Promise[src]
fetchThreadsArchivedPrivateJoined(
options: FetchChannelThreadsArchivedPrivateJoinedinterface FetchChannelThreadsArchivedPrivateJoineddetritus-client-rest/RequestTypes/FetchChannelThreadsArchivedPrivateJoined = {}
): Promise<FetchChannelThreadsArchivedPrivateJoinedinterface FetchChannelThreadsArchivedPrivateJoineddetritus-client/rest/RestResponses/FetchChannelThreadsArchivedPrivateJoined>external Promise[src]
fetchThreadsArchivedPublic(
options: FetchChannelThreadsArchivedPublicinterface FetchChannelThreadsArchivedPublicdetritus-client-rest/RequestTypes/FetchChannelThreadsArchivedPublic = {}
): Promise<FetchChannelThreadsArchivedPublicinterface FetchChannelThreadsArchivedPublicdetritus-client/rest/RestResponses/FetchChannelThreadsArchivedPublic>external Promise[src]
fetchWebhooks(
): Promise<BaseCollectionclass BaseCollectiondetritus-utils/BaseCollection<string, Webhookclass Webhookdetritus-client/structures/Webhook>>external Promise[src]
follow(
options: FollowChannelinterface FollowChanneldetritus-client-rest/RequestTypes/FollowChannel
): Promise<__type>external Promise[src]
grantEntitlement(): Promise<void>external Promise[src]
join(): Promise<void>external Promise[src]
2 more overloads
join(
options?: CallOptionsinterface CallOptionsdetritus-client/structures/CallOptions
): Promise<VoiceConnectObjectinterface VoiceConnectObjectdetritus-client/VoiceConnectObject | null>external Promise[src]
join(
options?: CallOptionsinterface CallOptionsdetritus-client/structures/CallOptions
): Promise<VoiceConnectObjectinterface VoiceConnectObjectdetritus-client/VoiceConnectObject | null | void>external Promise[src]
leave(): Promise<any>external Promise[src]
removeMember(userId: string): Promise<any>external Promise[src]
removeRecipient(userId: string): Promise<any>external Promise[src]
search(
options: SearchOptionsinterface SearchOptionsdetritus-client-rest/RequestTypes/SearchOptions,
retry?: boolean
): Promise<any>external Promise[src]
startCallRinging(recipients?: Array<string>external Array): Promise<any>external Promise[src]
stopCallRinging(recipients?: Array<string>external Array): Promise<any>external Promise[src]
triggerTyping(): Promise<any>external Promise[src]
turnIntoNewsChannel(
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
turnIntoTextChannel(
): Promise<ChannelGuildThreadclass ChannelGuildThreaddetritus-client/structures/ChannelGuildThread | ChannelGuildBaseclass ChannelGuildBasedetritus-client/structures/ChannelGuildBase | ChannelBaseclass ChannelBasedetritus-client/structures/ChannelBase | ChannelGuildTextclass ChannelGuildTextdetritus-client/structures/ChannelGuildText | ChannelDMclass ChannelDMdetritus-client/structures/ChannelDM | ChannelDMGroupclass ChannelDMGroupdetritus-client/structures/ChannelDMGroup | ChannelGuildVoiceclass ChannelGuildVoicedetritus-client/structures/ChannelGuildVoice | ChannelGuildCategoryclass ChannelGuildCategorydetritus-client/structures/ChannelGuildCategory | ChannelGuildStoreclass ChannelGuildStoredetritus-client/structures/ChannelGuildStore | ChannelGuildStageVoiceclass ChannelGuildStageVoicedetritus-client/structures/ChannelGuildStageVoice>external Promise[src]
unack(): Promise<any>external Promise[src]
mergeValue(key: string, value: any): void[src]